Cisco-IOS-XR-clns-isis-cfg API API Reference
API generated from Cisco-IOS-XR-clns-isis-cfg@2018-11-23.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key Mandatory OptionalPaths
INSTANCE - Update
Update operation of resource: instance
instancebody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ "max-nbr": "integer", Adjacency Stagger: Subsequent simultaneous\nnumber of neighbors to bring up
range: "2..65000"
default: "64"
"initial-nbr": "integer" Adjacency Stagger: Initial number of\nneighbors to bring up per area
range: "2..65000"
default: "2"
}, {
"authentication-type": "enumeration", SNP packet authentication mode
Options:
send-only
full
"enable-poi": "enumeration", Enable POI
Options:
enable-poi-off
enable-poi-on
"algorithm": "enumeration", Algorithm
Options:
cleartext
hmac-md5
keychain
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"password": "string", Password or unencrypted Key Chain name
"failure-mode": "enumeration" Failure Mode
Options:
drop
send-only
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "dist-throttle": "integer", Seconds
range: "1..20"
units: "second"
"dist-inst-id": "integer", Instance ID
range: "32..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
level1
level2
level1-and2
},
"log-pdu-drops": [ null ], Log PDU drops {
"affinity-name": "string", Affinity Name
"value": "integer" SID value for the interface
range: "0..255"
}
]
}, "lifetime": "integer", Seconds
range: "5..300"
units: "second"
default: "90"
"flavor": "enumeration", NSF not configured if item is deleted
Options:
cisco-proprietary-nsf
ietf-standard-nsf
"max-interface-timer-expiry": "integer", Maximum number of times an interface timer\nmay expire during an IETF-NSF restart before\nthe NSF restart is aborted. This\nconfiguration has no effect if IETF NSF is\nnot configured.
range: "1..10"
default: "10"
"interface-timer": "integer" Per-interface time period to wait for a\nrestart ACK during an IETF-NSF restart. This\nconfiguration has no effect if IETF-NSF is\nnot configured
range: "1..20"
units: "second"
default: "1"
},
"dynamic-host-name": "boolean", If TRUE, dynamic hostname resolution is\ndisabled, and system IDs will always be\ndisplayed by show and debug output.
"vrf-context": "string", VRF context for ISIS process {
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"mtu": "integer" Bytes
range: "128..4352"
units: "byte"
}
]
},
"nsr": [ null ], IS-IS NSR configuration {
"net-name": "string" Network Entity Title
}
]
},
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise. {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"inter-level-adv-type": "enumeration", Advertise prefixes across ISIS levels
Options:
inter-level
"overload-bit-mode": "enumeration", Circumstances under which the overload bit\nis set in the system LSP
Options:
permanently-set
startup-period
wait-for-bgp
"external-adv-type": "enumeration", Advertise prefixes from other protocols
Options:
external
"hippity-period": "integer", Time in seconds to advertise ourself as\noverloaded after process startup
range: "5..86400"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"lifetime": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"instance-id": "integer", Instance ID of the IS-IS process
range: "0..65535"
default: "0" {
"interval": "integer", Seconds
range: "10..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"ignore-lsp-errors": "boolean", If TRUE, LSPs recieved with bad checksums will\nresult in the purging of that LSP from the LSP\nDB. If FALSE or not set, the received LSP will\njust be ignored. {
"password": "string", Password or unencrypted Key Chain name
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"mesh-group": "string", Mesh-group configuration
range: "0..4294967295" {
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"multiplier": "integer" Hello multiplier value
range: "3..1000"
}
]
},
"point-to-point": [ null ], IS-IS will attempt to form point-to-point\nover LAN adjacencies over this interface. {
"interval": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "1..4294967295"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted {
"interval": "integer", Seconds
range: "0..65535"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "flex-algo": "string" Flex Algo
}
},
"interface-name": "string", Name of the interface to be excluded { {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
],
"link-down-fast-detect": [ null ], Configure high priority detection of\ninterface down event {
"padding-type": "enumeration", Hello padding type value
Options:
never
sometimes
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"password": "string", Password or unencrypted Key Chain name
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "0..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"count": "integer", Count
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "interval": "integer", Seconds
range: "3..30000"
units: "millisecond"
"enable-ipv4": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"enable-ipv6": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer" Detection multiplier for BFD sessions\ncreated by isis
range: "2..50"
}, {
"failure-mode": "enumeration", Failure Mode
Options:
drop
send-only
"password": "string", Password or unencrypted Key Chain name
"algorithm": "enumeration", Algorithm
Options:
cleartext
hmac-md5
keychain
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "0..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"state": "enumeration", State
Options:
shutdown
suppressed
passive
enabled-active {
"priority-value": "integer", Priority
range: "0..127"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"circuit-type": "enumeration", Configure circuit type for interface
Options:
level1
level2
level1-and2 {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6 {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"max-metric": "integer", Value of the metric
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
remote-lfa-none
remote-lfa-tunnel-ldp
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
node-protecting
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"proactive-protect": "integer", Allowed auto metric:<1-63> for narrow\n,<1-16777214> for wide
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "link-group": "string", No description
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
default: "0"
}, "sync-level": "integer" Enable MPLS LDP Synchronization for an\nIS-IS level
range: "0..2"
default: "0"
}, {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, {
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"algo": "integer", Algo
range: "128..255"
"nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
]
},
"interface-af-state": "enumeration", Interface state
Options:
disable : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
},
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"max-metric": "integer", Value of the metric
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
remote-lfa-none
remote-lfa-tunnel-ldp
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
node-protecting
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
},
"topology-name": "string", Topology Name : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, "link-group": "string", No description
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
default: "0"
}, "sync-level": "integer" Enable MPLS LDP Synchronization for an\nIS-IS level
range: "0..2"
default: "0"
}, {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, {
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"algo": "integer", Algo
range: "128..255"
"nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
]
},
"interface-af-state": "enumeration", Interface state
Options:
disable {
"proactive-protect": "integer", Allowed auto metric:<1-63> for narrow\n,<1-16777214> for wide
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}
]
}
]
}
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted "upper-bound": "integer", The upper bound of the SRGB
range: "16001..1048575"
"lower-bound": "integer" The lower bound of the SRGB
range: "16000..1048574"
}, {
"link-group-name": "string", Link Group Name
"revert-members": "integer", Revert Members
range: "2..64"
default: "2"
"metric-offset": "integer", Metric for redistributed routes: <0-63> for\nnarrow, <0-16777215> for wide
range: "0..16777215"
"minimum-members": "integer" Minimum Members
range: "2..64"
default: "2"
}
]
}, {
"priority": "integer", Compute for all prefixes upto the\nspecified priority
range: "0..255" "affinity-exclude-any": "string" Array of Attribute Names
},
"advertise-definition": "boolean", If TRUE, Flex-Algo definition is advertised
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"metric-type": "integer", IS-IS metric type
range: "1"
"flex-algo": "integer", Flex Algo
range: "128..255"
"frr-disable": "boolean" If TRUE, FRR protectinn is disabled for the\nFlex-Algo.
}
]
}, { { {
"remote-ipv4-address": "string", Remote IPv4 address
"local-ipv4-address": "string" Local IPv4 address
}
]
},
"srlg-name": "string", Srlg name
"admin-weight": "integer" Configure SRLG Admin Weight
range: "0..16777215"
}
]
},
"srlg-admin-weight-default": "integer" Configure Default SRLG Admin Weight
range: "0..16777215"
}
],
"tracing-mode": "enumeration", Tracing mode configuration
Options:
off
basic
enhanced
"is-type": "enumeration", IS type of the IS-IS process
Options:
level1
level2
level1-and2 "detailed": "integer", Buffer size for detailed traces
range: "1..1000000"
"severe": "integer", Buffer size for severe trace
range: "1..1000000"
"hello": "integer", Buffer size for hello trace
range: "1..1000000"
"standard": "integer" Buffer size for standard traces
range: "1..1000000"
},
"log-adjacency-changes": [ null ], Log changes in adjacency state {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ "max-nbr": "integer", Adjacency Stagger: Subsequent simultaneous\nnumber of neighbors to bring up
range: "2..65000"
default: "64"
"initial-nbr": "integer" Adjacency Stagger: Initial number of\nneighbors to bring up per area
range: "2..65000"
default: "2"
}, {
"authentication-type": "enumeration", SNP packet authentication mode
Options:
send-only
full
"enable-poi": "enumeration", Enable POI
Options:
enable-poi-off
enable-poi-on
"algorithm": "enumeration", Algorithm
Options:
cleartext
hmac-md5
keychain
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"password": "string", Password or unencrypted Key Chain name
"failure-mode": "enumeration" Failure Mode
Options:
drop
send-only
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "dist-throttle": "integer", Seconds
range: "1..20"
units: "second"
"dist-inst-id": "integer", Instance ID
range: "32..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
level1
level2
level1-and2
},
"log-pdu-drops": [ null ], Log PDU drops {
"affinity-name": "string", Affinity Name
"value": "integer" SID value for the interface
range: "0..255"
}
]
}, "lifetime": "integer", Seconds
range: "5..300"
units: "second"
default: "90"
"flavor": "enumeration", NSF not configured if item is deleted
Options:
cisco-proprietary-nsf
ietf-standard-nsf
"max-interface-timer-expiry": "integer", Maximum number of times an interface timer\nmay expire during an IETF-NSF restart before\nthe NSF restart is aborted. This\nconfiguration has no effect if IETF NSF is\nnot configured.
range: "1..10"
default: "10"
"interface-timer": "integer" Per-interface time period to wait for a\nrestart ACK during an IETF-NSF restart. This\nconfiguration has no effect if IETF-NSF is\nnot configured
range: "1..20"
units: "second"
default: "1"
},
"dynamic-host-name": "boolean", If TRUE, dynamic hostname resolution is\ndisabled, and system IDs will always be\ndisplayed by show and debug output.
"vrf-context": "string", VRF context for ISIS process {
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"mtu": "integer" Bytes
range: "128..4352"
units: "byte"
}
]
},
"nsr": [ null ], IS-IS NSR configuration {
"net-name": "string" Network Entity Title
}
]
},
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise. {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"inter-level-adv-type": "enumeration", Advertise prefixes across ISIS levels
Options:
inter-level
"overload-bit-mode": "enumeration", Circumstances under which the overload bit\nis set in the system LSP
Options:
permanently-set
startup-period
wait-for-bgp
"external-adv-type": "enumeration", Advertise prefixes from other protocols
Options:
external
"hippity-period": "integer", Time in seconds to advertise ourself as\noverloaded after process startup
range: "5..86400"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"lifetime": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"instance-id": "integer", Instance ID of the IS-IS process
range: "0..65535"
default: "0" {
"interval": "integer", Seconds
range: "10..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"ignore-lsp-errors": "boolean", If TRUE, LSPs recieved with bad checksums will\nresult in the purging of that LSP from the LSP\nDB. If FALSE or not set, the received LSP will\njust be ignored. {
"password": "string", Password or unencrypted Key Chain name
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"mesh-group": "string", Mesh-group configuration
range: "0..4294967295" {
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"multiplier": "integer" Hello multiplier value
range: "3..1000"
}
]
},
"point-to-point": [ null ], IS-IS will attempt to form point-to-point\nover LAN adjacencies over this interface. {
"interval": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "1..4294967295"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted {
"interval": "integer", Seconds
range: "0..65535"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "flex-algo": "string" Flex Algo
}
},
"interface-name": "string", Name of the interface to be excluded { {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
],
"link-down-fast-detect": [ null ], Configure high priority detection of\ninterface down event {
"padding-type": "enumeration", Hello padding type value
Options:
never
sometimes
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"password": "string", Password or unencrypted Key Chain name
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "0..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"count": "integer", Count
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "interval": "integer", Seconds
range: "3..30000"
units: "millisecond"
"enable-ipv4": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"enable-ipv6": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer" Detection multiplier for BFD sessions\ncreated by isis
range: "2..50"
}, {
"failure-mode": "enumeration", Failure Mode
Options:
drop
send-only
"password": "string", Password or unencrypted Key Chain name
"algorithm": "enumeration", Algorithm
Options:
cleartext
hmac-md5
keychain
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "0..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"state": "enumeration", State
Options:
shutdown
suppressed
passive
enabled-active {
"priority-value": "integer", Priority
range: "0..127"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"circuit-type": "enumeration", Configure circuit type for interface
Options:
level1
level2
level1-and2 {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6 {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"max-metric": "integer", Value of the metric
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
remote-lfa-none
remote-lfa-tunnel-ldp
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
node-protecting
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"proactive-protect": "integer", Allowed auto metric:<1-63> for narrow\n,<1-16777214> for wide
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "link-group": "string", No description
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
default: "0"
}, "sync-level": "integer" Enable MPLS LDP Synchronization for an\nIS-IS level
range: "0..2"
default: "0"
}, {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, {
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"algo": "integer", Algo
range: "128..255"
"nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
]
},
"interface-af-state": "enumeration", Interface state
Options:
disable : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
},
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"max-metric": "integer", Value of the metric
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
remote-lfa-none
remote-lfa-tunnel-ldp
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
node-protecting
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
},
"topology-name": "string", Topology Name : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, "link-group": "string", No description
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
default: "0"
}, "sync-level": "integer" Enable MPLS LDP Synchronization for an\nIS-IS level
range: "0..2"
default: "0"
}, {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, {
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"algo": "integer", Algo
range: "128..255"
"nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
]
},
"interface-af-state": "enumeration", Interface state
Options:
disable {
"proactive-protect": "integer", Allowed auto metric:<1-63> for narrow\n,<1-16777214> for wide
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}
]
}
]
}
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted "upper-bound": "integer", The upper bound of the SRGB
range: "16001..1048575"
"lower-bound": "integer" The lower bound of the SRGB
range: "16000..1048574"
}, {
"link-group-name": "string", Link Group Name
"revert-members": "integer", Revert Members
range: "2..64"
default: "2"
"metric-offset": "integer", Metric for redistributed routes: <0-63> for\nnarrow, <0-16777215> for wide
range: "0..16777215"
"minimum-members": "integer" Minimum Members
range: "2..64"
default: "2"
}
]
}, {
"priority": "integer", Compute for all prefixes upto the\nspecified priority
range: "0..255" "affinity-exclude-any": "string" Array of Attribute Names
},
"advertise-definition": "boolean", If TRUE, Flex-Algo definition is advertised
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"metric-type": "integer", IS-IS metric type
range: "1"
"flex-algo": "integer", Flex Algo
range: "128..255"
"frr-disable": "boolean" If TRUE, FRR protectinn is disabled for the\nFlex-Algo.
}
]
}, { { {
"remote-ipv4-address": "string", Remote IPv4 address
"local-ipv4-address": "string" Local IPv4 address
}
]
},
"srlg-name": "string", Srlg name
"admin-weight": "integer" Configure SRLG Admin Weight
range: "0..16777215"
}
]
},
"srlg-admin-weight-default": "integer" Configure Default SRLG Admin Weight
range: "0..16777215"
}
],
"tracing-mode": "enumeration", Tracing mode configuration
Options:
off
basic
enhanced
"is-type": "enumeration", IS type of the IS-IS process
Options:
level1
level2
level1-and2 "detailed": "integer", Buffer size for detailed traces
range: "1..1000000"
"severe": "integer", Buffer size for severe trace
range: "1..1000000"
"hello": "integer", Buffer size for hello trace
range: "1..1000000"
"standard": "integer" Buffer size for standard traces
range: "1..1000000"
},
"log-adjacency-changes": [ null ], Log changes in adjacency state {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-nbr": "integer", Adjacency Stagger: Subsequent simultaneous\nnumber of neighbors to bring up
range: "2..65000"
default: "64"
"initial-nbr": "integer" Adjacency Stagger: Initial number of\nneighbors to bring up per area
range: "2..65000"
default: "2"
}, {
"authentication-type": "enumeration", SNP packet authentication mode
Options:
send-only
full
"enable-poi": "enumeration", Enable POI
Options:
enable-poi-off
enable-poi-on
"algorithm": "enumeration", Algorithm
Options:
cleartext
hmac-md5
keychain
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"password": "string", Password or unencrypted Key Chain name
"failure-mode": "enumeration" Failure Mode
Options:
drop
send-only
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "dist-throttle": "integer", Seconds
range: "1..20"
units: "second"
"dist-inst-id": "integer", Instance ID
range: "32..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
level1
level2
level1-and2
},
"log-pdu-drops": [ null ], Log PDU drops {
"affinity-name": "string", Affinity Name
"value": "integer" SID value for the interface
range: "0..255"
}
]
}, "lifetime": "integer", Seconds
range: "5..300"
units: "second"
default: "90"
"flavor": "enumeration", NSF not configured if item is deleted
Options:
cisco-proprietary-nsf
ietf-standard-nsf
"max-interface-timer-expiry": "integer", Maximum number of times an interface timer\nmay expire during an IETF-NSF restart before\nthe NSF restart is aborted. This\nconfiguration has no effect if IETF NSF is\nnot configured.
range: "1..10"
default: "10"
"interface-timer": "integer" Per-interface time period to wait for a\nrestart ACK during an IETF-NSF restart. This\nconfiguration has no effect if IETF-NSF is\nnot configured
range: "1..20"
units: "second"
default: "1"
},
"dynamic-host-name": "boolean", If TRUE, dynamic hostname resolution is\ndisabled, and system IDs will always be\ndisplayed by show and debug output.
"vrf-context": "string", VRF context for ISIS process {
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"mtu": "integer" Bytes
range: "128..4352"
units: "byte"
}
]
},
"nsr": [ null ], IS-IS NSR configuration {
"net-name": "string" Network Entity Title
}
]
},
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise. {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"inter-level-adv-type": "enumeration", Advertise prefixes across ISIS levels
Options:
inter-level
"overload-bit-mode": "enumeration", Circumstances under which the overload bit\nis set in the system LSP
Options:
permanently-set
startup-period
wait-for-bgp
"external-adv-type": "enumeration", Advertise prefixes from other protocols
Options:
external
"hippity-period": "integer", Time in seconds to advertise ourself as\noverloaded after process startup
range: "5..86400"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"lifetime": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"instance-id": "integer", Instance ID of the IS-IS process
range: "0..65535"
default: "0" {
"interval": "integer", Seconds
range: "10..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"ignore-lsp-errors": "boolean", If TRUE, LSPs recieved with bad checksums will\nresult in the purging of that LSP from the LSP\nDB. If FALSE or not set, the received LSP will\njust be ignored. {
"password": "string", Password or unencrypted Key Chain name
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"mesh-group": "string", Mesh-group configuration
range: "0..4294967295" {
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"multiplier": "integer" Hello multiplier value
range: "3..1000"
}
]
},
"point-to-point": [ null ], IS-IS will attempt to form point-to-point\nover LAN adjacencies over this interface. {
"interval": "integer", Seconds
range: "1..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "1..4294967295"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted {
"interval": "integer", Seconds
range: "0..65535"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "flex-algo": "string" Flex Algo
}
},
"interface-name": "string", Name of the interface to be excluded { {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
],
"link-down-fast-detect": [ null ], Configure high priority detection of\ninterface down event {
"padding-type": "enumeration", Hello padding type value
Options:
never
sometimes
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"password": "string", Password or unencrypted Key Chain name
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "0..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"count": "integer", Count
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "interval": "integer", Seconds
range: "3..30000"
units: "millisecond"
"enable-ipv4": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"enable-ipv6": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer" Detection multiplier for BFD sessions\ncreated by isis
range: "2..50"
}, {
"failure-mode": "enumeration", Failure Mode
Options:
drop
send-only
"password": "string", Password or unencrypted Key Chain name
"algorithm": "enumeration", Algorithm
Options:
cleartext
hmac-md5
keychain
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interval": "integer", Seconds
range: "0..65535"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"state": "enumeration", State
Options:
shutdown
suppressed
passive
enabled-active {
"priority-value": "integer", Priority
range: "0..127"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"circuit-type": "enumeration", Configure circuit type for interface
Options:
level1
level2
level1-and2 {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6 {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"max-metric": "integer", Value of the metric
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
remote-lfa-none
remote-lfa-tunnel-ldp
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
node-protecting
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"proactive-protect": "integer", Allowed auto metric:<1-63> for narrow\n,<1-16777214> for wide
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "link-group": "string", No description
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
default: "0"
}, "sync-level": "integer" Enable MPLS LDP Synchronization for an\nIS-IS level
range: "0..2"
default: "0"
}, {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, {
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"algo": "integer", Algo
range: "128..255"
"nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
]
},
"interface-af-state": "enumeration", Interface state
Options:
disable : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
},
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"max-metric": "integer", Value of the metric
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"type": "enumeration", SID type for the interface
Options:
remote-lfa-none
remote-lfa-tunnel-ldp
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"interface-name": "string", Name of the interface to be excluded
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
}
]
}, {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
node-protecting
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
},
"topology-name": "string", Topology Name : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, "link-group": "string", No description
"level": "integer" SPF Level for prefix prioritization
range: "0..2"
default: "0"
}, "sync-level": "integer" Enable MPLS LDP Synchronization for an\nIS-IS level
range: "0..2"
default: "0"
}, {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}, {
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"algo": "integer", Algo
range: "128..255"
"nflag-clear": "enumeration", Clear N-flag for the prefix-SID
Options:
disable
enable
"php": "enumeration", Enable/Disable Penultimate Hop Popping
Options:
enable
disable
"type": "enumeration", SID type for the interface
Options:
index
absolute
"value": "integer", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration" Enable/Disable Explicit-NULL flag
Options:
disable
enable
}
]
},
"interface-af-state": "enumeration", Interface state
Options:
disable {
"proactive-protect": "integer", Allowed auto metric:<1-63> for narrow\n,<1-16777214> for wide
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}
]
}
]
}
}
]
},
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted "upper-bound": "integer", The upper bound of the SRGB
range: "16001..1048575"
"lower-bound": "integer" The lower bound of the SRGB
range: "16000..1048574"
}, {
"link-group-name": "string", Link Group Name
"revert-members": "integer", Revert Members
range: "2..64"
default: "2"
"metric-offset": "integer", Metric for redistributed routes: <0-63> for\nnarrow, <0-16777215> for wide
range: "0..16777215"
"minimum-members": "integer" Minimum Members
range: "2..64"
default: "2"
}
]
}, {
"priority": "integer", Compute for all prefixes upto the\nspecified priority
range: "0..255" "affinity-exclude-any": "string" Array of Attribute Names
},
"advertise-definition": "boolean", If TRUE, Flex-Algo definition is advertised
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"metric-type": "integer", IS-IS metric type
range: "1"
"flex-algo": "integer", Flex Algo
range: "128..255"
"frr-disable": "boolean" If TRUE, FRR protectinn is disabled for the\nFlex-Algo.
}
]
}, { { {
"remote-ipv4-address": "string", Remote IPv4 address
"local-ipv4-address": "string" Local IPv4 address
}
]
},
"srlg-name": "string", Srlg name
"admin-weight": "integer" Configure SRLG Admin Weight
range: "0..16777215"
}
]
},
"srlg-admin-weight-default": "integer" Configure Default SRLG Admin Weight
range: "0..16777215"
}
],
"tracing-mode": "enumeration", Tracing mode configuration
Options:
off
basic
enhanced
"is-type": "enumeration", IS type of the IS-IS process
Options:
level1
level2
level1-and2 "detailed": "integer", Buffer size for detailed traces
range: "1..1000000"
"severe": "integer", Buffer size for severe trace
range: "1..1000000"
"hello": "integer", Buffer size for hello trace
range: "1..1000000"
"standard": "integer" Buffer size for standard traces
range: "1..1000000"
},
"log-adjacency-changes": [ null ], Log changes in adjacency state {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
}
}
SRGB - Update
Update operation of resource: srgb
srgbbody object
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRGB - Create
Create operation of resource: srgb
srgbbody object
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRGB - Delete
Delete operation of resource: srgb
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRGB - Retrieve
Retrieve operation of resource: srgb
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
LSP-GENERATION-INTERVALS - Update
Update operation of resource: lsp-generation-intervals
lsp-generation-intervalsbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before generating local LSP\nin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-GENERATION-INTERVALS - Create
Create operation of resource: lsp-generation-intervals
lsp-generation-intervalsbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before generating local LSP\nin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-GENERATION-INTERVALS - Delete
Delete operation of resource: lsp-generation-intervals
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-GENERATION-INTERVALS - Retrieve
Retrieve operation of resource: lsp-generation-intervals
instance-name:
string
in path
ID of instance-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"maximum-wait": "integer", Maximum wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before generating local LSP\nin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
LSP-GENERATION-INTERVAL - Update
Update operation of resource: lsp-generation-interval
lsp-generation-intervalbody object
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before generating local LSP\nin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-GENERATION-INTERVAL - Create
Create operation of resource: lsp-generation-interval
lsp-generation-intervalbody object
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before generating local LSP\nin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-GENERATION-INTERVAL - Delete
Delete operation of resource: lsp-generation-interval
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-GENERATION-INTERVAL - Retrieve
Retrieve operation of resource: lsp-generation-interval
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"maximum-wait": "integer", Maximum wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before generating local LSP in\nmilliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before generating local LSP\nin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
LSP-ARRIVAL-TIMES - Update
Update operation of resource: lsp-arrival-times
lsp-arrival-timesbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-ARRIVAL-TIMES - Create
Create operation of resource: lsp-arrival-times
lsp-arrival-timesbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-ARRIVAL-TIMES - Delete
Delete operation of resource: lsp-arrival-times
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-ARRIVAL-TIMES - Retrieve
Retrieve operation of resource: lsp-arrival-times
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"maximum-wait": "integer", Maximum delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
LSP-ARRIVAL-TIME - Update
Update operation of resource: lsp-arrival-time
lsp-arrival-timebody object
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-ARRIVAL-TIME - Create
Create operation of resource: lsp-arrival-time
lsp-arrival-timebody object
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
Request Content-Types: application/json
Request Example
{ {
"maximum-wait": "integer", Maximum delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-ARRIVAL-TIME - Delete
Delete operation of resource: lsp-arrival-time
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
LSP-ARRIVAL-TIME - Retrieve
Retrieve operation of resource: lsp-arrival-time
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"maximum-wait": "integer", Maximum delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary delay expected to take since last\nLSPin milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
TRACE-BUFFER-SIZE - Update
Update operation of resource: trace-buffer-size
trace-buffer-sizebody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ "detailed": "integer", Buffer size for detailed traces
range: "1..1000000"
"severe": "integer", Buffer size for severe trace
range: "1..1000000"
"hello": "integer", Buffer size for hello trace
range: "1..1000000"
"standard": "integer" Buffer size for standard traces
range: "1..1000000"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TRACE-BUFFER-SIZE - Create
Create operation of resource: trace-buffer-size
trace-buffer-sizebody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ "detailed": "integer", Buffer size for detailed traces
range: "1..1000000"
"severe": "integer", Buffer size for severe trace
range: "1..1000000"
"hello": "integer", Buffer size for hello trace
range: "1..1000000"
"standard": "integer" Buffer size for standard traces
range: "1..1000000"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TRACE-BUFFER-SIZE - Delete
Delete operation of resource: trace-buffer-size
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
TRACE-BUFFER-SIZE - Retrieve
Retrieve operation of resource: trace-buffer-size
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "detailed": "integer", Buffer size for detailed traces
range: "1..1000000"
"severe": "integer", Buffer size for severe trace
range: "1..1000000"
"hello": "integer", Buffer size for hello trace
range: "1..1000000"
"standard": "integer" Buffer size for standard traces
range: "1..1000000"
}
}
MAX-LINK-METRICS - Update
Update operation of resource: max-link-metrics
max-link-metricsbody object
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAX-LINK-METRICS - Create
Create operation of resource: max-link-metrics
max-link-metricsbody object
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAX-LINK-METRICS - Delete
Delete operation of resource: max-link-metrics
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAX-LINK-METRICS - Retrieve
Retrieve operation of resource: max-link-metrics
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
MAX-LINK-METRIC - Update
Update operation of resource: max-link-metric
max-link-metricbody object
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAX-LINK-METRIC - Create
Create operation of resource: max-link-metric
max-link-metricbody object
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAX-LINK-METRIC - Delete
Delete operation of resource: max-link-metric
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MAX-LINK-METRIC - Retrieve
Retrieve operation of resource: max-link-metric
instance-name:
string
in path
ID of instance-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
ADJACENCY-STAGGER - Update
Update operation of resource: adjacency-stagger
adjacency-staggerbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ "max-nbr": "integer", Adjacency Stagger: Subsequent simultaneous\nnumber of neighbors to bring up
range: "2..65000"
default: "64"
"initial-nbr": "integer" Adjacency Stagger: Initial number of\nneighbors to bring up per area
range: "2..65000"
default: "2"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ADJACENCY-STAGGER - Create
Create operation of resource: adjacency-stagger
adjacency-staggerbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ "max-nbr": "integer", Adjacency Stagger: Subsequent simultaneous\nnumber of neighbors to bring up
range: "2..65000"
default: "64"
"initial-nbr": "integer" Adjacency Stagger: Initial number of\nneighbors to bring up per area
range: "2..65000"
default: "2"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ADJACENCY-STAGGER - Delete
Delete operation of resource: adjacency-stagger
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ADJACENCY-STAGGER - Retrieve
Retrieve operation of resource: adjacency-stagger
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "max-nbr": "integer", Adjacency Stagger: Subsequent simultaneous\nnumber of neighbors to bring up
range: "2..65000"
default: "64"
"initial-nbr": "integer" Adjacency Stagger: Initial number of\nneighbors to bring up per area
range: "2..65000"
default: "2"
}
}
AFS - Update
Update operation of resource: afs
afsbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
instance-name:
string
in path
ID of instance-name
Request Content-Types: application/json
Request Example
{ {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
instance-name:
string
in path
ID of instance-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
}
AF - Update
Update operation of resource: af
afbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"af-name": "enumeration", Address family
Options:
ipv4
ipv6
"saf-name": "enumeration", Sub address family
Options:
unicast
multicast { {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"topology-name": "string", Topology Name
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
], {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
]
}
AF-DATA - Update
Update operation of resource: af-data
af-databody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF-DATA - Create
Create operation of resource: af-data
af-databody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF-DATA - Delete
Delete operation of resource: af-data
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
AF-DATA - Retrieve
Retrieve operation of resource: af-data
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"address-prefix": "string", IP address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" SPF Level for prefix prioritization
range: "1..2"
}
]
},
"advertise-passive-only": [ null ], If enabled, advertise prefixes of passive\ninterfaces only {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the Prefix List
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}, {
"route-policy-name": "string", Route policy to control redistribution.
"destination-level": "enumeration", Destination level for routes. Must\ndiffer from SourceLevel
Options:
not-set
level1
level2
"source-level": "enumeration" Source level for routes
Options:
not-set
level1
level2
}
]
},
"ignore-attached-bit": "boolean", If TRUE, Ignore other routers attached bit "track-ip-frr": [ null ], Enable the Tracking of IP-Frr Convergence
"prefix-list": "string", List of prefixes to which this distance\napplies
"enable": [ null ] UCMP feature enable configuration
},
"apply-weight": "enumeration", Apply weights to UCMP or ECMP only
Options:
ecmp-only
ucmp-only
ecmp-only-bandwidth : { "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
}, {
"periodic-interval": "integer", Maximum interval in between SPF runs in\nseconds
range: "0..3600"
units: "second"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"distance": "integer", Administrative distance
range: "1..255"
"prefix-list": "string", List of prefixes to which this distance\napplies
"address-prefix": "string" IP address prefix
}
]
}, : { "auto-config": "boolean" If TRUE, LDP will be enabled onall IS-IS\ninterfaces enabled for this address-family
}, {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"level": "enumeration", SPF Level for prefix prioritization
Options:
not-set
level1
level2
"protected": "enumeration", Enable/Disable SID protection
Options:
disable
enable
"sid": "string" SID value for the interface
range: "0..1048575"
}
]
}, {
"maximum-wait": "integer", Maximum wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"initial-wait": "integer", Initial wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"secondary-wait": "integer", Secondary wait before running a route\ncalculation in milliseconds
range: "0..120000"
units: "millisecond"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
},
"maximum-paths": "integer", Maximum number of active parallel paths per\nroute
range: "1..64"
"adjacency-check": "enumeration", Suppress check for consistent AF support on\nreceived IIHs
Options:
disabled {
"metric": "string", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "1..16777215"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", MPLS configuration. MPLS configuration will\nonly be applied for the IPv4-unicast\naddress-family.
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
},
"advertise-link-attributes": "boolean", If TRUE, advertise additional link\nattributes in our LSP "prefix-list-name": "string", Name of the Prefix List
"route-policy-name": "string" Route policy to control redistribution.
},
"single-topology": [ null ], Run IPv6 Unicast using the standard (IPv4\nUnicast) topology : { "policy-name": "string", Policy name
"external": [ null ], Flag to indicate that the default prefix\nshould be originated as an external route
"use-policy": "boolean" Flag to indicate whether default\norigination is controlled using a policy
}, {
"state": "enumeration", State
Options:
enabled
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
},
"topology-id": "integer", Set the topology ID for a named\n(non-default) topology. This object must be\nset before any other configuration is\nsupplied for a named (non-default) topology\n, and must be the last configuration object\nto be removed. This item should not be\nsupplied for the non-named default\ntopologies.
range: "6..4095" "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" UCMP feature enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
},
"route-source-first-hop": "boolean", If TRUE, routes will be installed with the\nIP address of the first-hop node as the\nsource instead of the originating node
"default-admin-distance": "integer", Default IS-IS administrative distance\nconfiguration.
range: "1..255"
default: "115" { {
"enable": "boolean", UCMP feature enable configuration
"app-type": "enumeration" Application Type
Options:
srlg
}
],
"app-type": "enumeration" Application Type
Options:
lfa
}
]
}, { {
"as-xx": "integer", First half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP\nand must not be specified otherwise.\nMust be a non-zero value if second half\nis zero.
range: "0..65535"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-yy": "integer", Second half of BGP AS number in XX.YY\nformat. Mandatory if Protocol is BGP and\nmust not be specified otherwise. Must be\na non-zero value if first half is zero.
range: "0..4294967295"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
], {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"as-zz": "integer", Eigrp as number.
range: "1..65535"
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
],
"protocol-name": "enumeration", The protocol to be redistributed. OSPFv3\nmay not be specified for an IPv4 topology\nand OSPF may not be specified for an IPv6\ntopology.
Options:
connected
static
ospf
bgp
isis
ospfv3
rip
eigrp
subscriber
application
mobile "metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}, {
"levels": "enumeration", Levels to redistribute routes into
Options:
level1
level2
level1-and2
"instance-name": "string", Protocol Instance Identifier. Mandatory\nfor ISIS, OSPF and application, must not\nbe specified otherwise.
"metric": "integer", Metric for redistributed routes: <0-63>\nfor narrow, <0-16777215> for wide
range: "0..16777215"
"metric-type": "enumeration", IS-IS metric type
Options:
internal
external
rib-internal
rib-external
"ospf-route-type": "integer", OSPF route types to redistribute. May\nonly be specified if Protocol is OSPF.
"route-policy-name": "string" Route policy to control redistribution.
}
]
}
]
},
"attached-bit": "enumeration", Set the attached bit in this router's level\n1 System LSP
Options:
area
on
off {
"prefix-limit": "integer", Max number of prefixes
range: "1..28000"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, : { "multicast-intact": [ null ], Install non-TE nexthops in the RIB for use\nby multicast "interface-name": "string", Name of the interface to be excluded
"address": "string" IPv4 address to be used as a router ID.\nPrecisely one of Address and Interface\nmust be specified.
},
"igp-intact": [ null ], Install TE and non-TE nexthops in the RIB "level1": "boolean", Level 1 enabled
"level2": "boolean" Level 2 enabled
}
}, : [ {
"weight": "integer", Weight to be configured under interface for\nLoad Balancing. Allowed weight: <1-16777215>
range: "1..16777214"
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}, {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
}
SEGMENT-ROUTING - Update
Update operation of resource: segment-routing
segment-routingbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", Prefer segment routing labels over LDP\nlabels
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SEGMENT-ROUTING - Create
Create operation of resource: segment-routing
segment-routingbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", Prefer segment routing labels over LDP\nlabels
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SEGMENT-ROUTING - Delete
Delete operation of resource: segment-routing
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SEGMENT-ROUTING - Retrieve
Retrieve operation of resource: segment-routing
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "bundle-member-adj-sid": [ null ], Enable per bundle member adjacency SID "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
},
"mpls": "enumeration", Prefer segment routing labels over LDP\nlabels
Options:
ldp
segment-routing {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}, {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
},
"labeled-only": [ null ] Only install SR labeled paths
}
}
SRV6 - Update
Update operation of resource: srv6
srv6body object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6 - Create
Create operation of resource: srv6
srv6body object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6 - Delete
Delete operation of resource: srv6
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6 - Retrieve
Retrieve operation of resource: srv6
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"running": [ null ], The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
"locator-name": "string" Locator Name
}
]
},
"running": [ null ] The presence of this object enables SRv6.\nThis must be the first object created\nunder the SRV6 container, and the last\none deleted
}
}
SRV6-LOCATORS - Update
Update operation of resource: srv6-locators
srv6-locatorsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"running": [ null ], The presence of this object enables a\nSRv6 Locator. This must be the first\nobject created under the SRv6Locator\ncontainer, and the last one deleted
"locator-name": "string" Locator Name
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6-LOCATORS - Create
Create operation of resource: srv6-locators
srv6-locatorsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"running": [ null ], The presence of this object enables a\nSRv6 Locator. This must be the first\nobject created under the SRv6Locator\ncontainer, and the last one deleted
"locator-name": "string" Locator Name
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6-LOCATORS - Delete
Delete operation of resource: srv6-locators
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6-LOCATORS - Retrieve
Retrieve operation of resource: srv6-locators
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"running": [ null ], The presence of this object enables a\nSRv6 Locator. This must be the first\nobject created under the SRv6Locator\ncontainer, and the last one deleted
"locator-name": "string" Locator Name
}
]
}
}
SRV6-LOCATOR - Update
Update operation of resource: srv6-locator
srv6-locatorbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
locator-name:
string
in path
ID of locator-name
Request Content-Types: application/json
Request Example
{ {
"running": [ null ], The presence of this object enables a\nSRv6 Locator. This must be the first\nobject created under the SRv6Locator\ncontainer, and the last one deleted
"locator-name": "string" Locator Name
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6-LOCATOR - Create
Create operation of resource: srv6-locator
srv6-locatorbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
locator-name:
string
in path
ID of locator-name
Request Content-Types: application/json
Request Example
{ {
"running": [ null ], The presence of this object enables a\nSRv6 Locator. This must be the first\nobject created under the SRv6Locator\ncontainer, and the last one deleted
"locator-name": "string" Locator Name
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6-LOCATOR - Delete
Delete operation of resource: srv6-locator
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
locator-name:
string
in path
ID of locator-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SRV6-LOCATOR - Retrieve
Retrieve operation of resource: srv6-locator
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
locator-name:
string
in path
ID of locator-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"running": [ null ], The presence of this object enables a\nSRv6 Locator. This must be the first\nobject created under the SRv6Locator\ncontainer, and the last one deleted
"locator-name": "string" Locator Name
}
]
}
CONNECTED-PREFIX-SIDS - Update
Update operation of resource: connected-prefix-sids
connected-prefix-sidsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CONNECTED-PREFIX-SIDS - Create
Create operation of resource: connected-prefix-sids
connected-prefix-sidsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CONNECTED-PREFIX-SIDS - Delete
Delete operation of resource: connected-prefix-sids
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CONNECTED-PREFIX-SIDS - Retrieve
Retrieve operation of resource: connected-prefix-sids
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}
}
CONNECTED-PREFIX-SID - Update
Update operation of resource: connected-prefix-sid
connected-prefix-sidbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix algo:
string
in path
ID of address-prefix algo
Request Content-Types: application/json
Request Example
{ {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CONNECTED-PREFIX-SID - Create
Create operation of resource: connected-prefix-sid
connected-prefix-sidbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix algo:
string
in path
ID of address-prefix algo
Request Content-Types: application/json
Request Example
{ {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CONNECTED-PREFIX-SID - Delete
Delete operation of resource: connected-prefix-sid
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix algo:
string
in path
ID of address-prefix algo
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
CONNECTED-PREFIX-SID - Retrieve
Retrieve operation of resource: connected-prefix-sid
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix algo:
string
in path
ID of address-prefix algo
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"sid-type": "enumeration", SID type for the interface
Options:
index
absolute
"sid": "string", SID value for the interface
range: "0..1048575"
"explicit-null": "enumeration", Enable/Disable Explicit-NULL flag
Options:
disable
enable
"sid-range": "integer", Range of SIDs
range: "1..1048575"
"algo": "integer", Algo
range: "0..255"
"address-prefix": "string", IP address prefix
"interface": "string", Interface to which prefix belongs
"php": "enumeration" Enable/Disable Penultimate Hop Popping
Options:
enable
disable
}
]
}
PREFIX-SID-MAP - Update
Update operation of resource: prefix-sid-map
prefix-sid-mapbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PREFIX-SID-MAP - Create
Create operation of resource: prefix-sid-map
prefix-sid-mapbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PREFIX-SID-MAP - Delete
Delete operation of resource: prefix-sid-map
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PREFIX-SID-MAP - Retrieve
Retrieve operation of resource: prefix-sid-map
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "receive": "boolean", If TRUE, remote prefix SID map\nadvertisements will be used. If FALSE,\nthey will not be used.
"advertise-local": [ null ] Enable Segment Routing prefix SID map\nadvertise local
}
}
METRIC-STYLES - Update
Update operation of resource: metric-styles
metric-stylesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC-STYLES - Create
Create operation of resource: metric-styles
metric-stylesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC-STYLES - Delete
Delete operation of resource: metric-styles
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC-STYLES - Retrieve
Retrieve operation of resource: metric-styles
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
METRIC-STYLE - Update
Update operation of resource: metric-style
metric-stylebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
Request Content-Types: application/json
Request Example
{ {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC-STYLE - Create
Create operation of resource: metric-style
metric-stylebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
Request Content-Types: application/json
Request Example
{ {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC-STYLE - Delete
Delete operation of resource: metric-style
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
METRIC-STYLE - Retrieve
Retrieve operation of resource: metric-style
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"style": "enumeration", Metric Style
Options:
old-metric-style
new-metric-style
both-metric-style
old-metric-style-transition
new-metric-style-transition
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
FRR-TABLE - Update
Update operation of resource: frr-table
frr-tablebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the prefix list
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TABLE - Create
Create operation of resource: frr-table
frr-tablebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the prefix list
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TABLE - Delete
Delete operation of resource: frr-table
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TABLE - Retrieve
Retrieve operation of resource: frr-table
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"prefix-list-name": "string", Name of the prefix list
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
},
"frr-initial-delay": "integer", Delay before running FRR (milliseconds)
range: "100..60000"
units: "millisecond" {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}, {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
}
FRR-LOAD-SHARINGS - Update
Update operation of resource: frr-load-sharings
frr-load-sharingsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-LOAD-SHARINGS - Create
Create operation of resource: frr-load-sharings
frr-load-sharingsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-LOAD-SHARINGS - Delete
Delete operation of resource: frr-load-sharings
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-LOAD-SHARINGS - Retrieve
Retrieve operation of resource: frr-load-sharings
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"load-sharing": "enumeration", Load sharing
Options:
disable
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
FRR-LOAD-SHARING - Update
Update operation of resource: frr-load-sharing
frr-load-sharingbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-LOAD-SHARING - Create
Create operation of resource: frr-load-sharing
frr-load-sharingbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-LOAD-SHARING - Delete
Delete operation of resource: frr-load-sharing
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-LOAD-SHARING - Retrieve
Retrieve operation of resource: frr-load-sharing
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
FRRSRLG-PROTECTION-TYPES - Update
Update operation of resource: frrsrlg-protection-types
frrsrlg-protection-typesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRRSRLG-PROTECTION-TYPES - Create
Create operation of resource: frrsrlg-protection-types
frrsrlg-protection-typesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRRSRLG-PROTECTION-TYPES - Delete
Delete operation of resource: frrsrlg-protection-types
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRRSRLG-PROTECTION-TYPES - Retrieve
Retrieve operation of resource: frrsrlg-protection-types
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"protection-type": "enumeration", Protection Type
Options:
local
weighted-global
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
FRRSRLG-PROTECTION-TYPE - Update
Update operation of resource: frrsrlg-protection-type
frrsrlg-protection-typebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRRSRLG-PROTECTION-TYPE - Create
Create operation of resource: frrsrlg-protection-type
frrsrlg-protection-typebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRRSRLG-PROTECTION-TYPE - Delete
Delete operation of resource: frrsrlg-protection-type
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRRSRLG-PROTECTION-TYPE - Retrieve
Retrieve operation of resource: frrsrlg-protection-type
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
Successful operation
400 Bad Request
Internal Error
PRIORITY-LIMITS - Update
Update operation of resource: priority-limits
priority-limitsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PRIORITY-LIMITS - Create
Create operation of resource: priority-limits
priority-limitsbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PRIORITY-LIMITS - Delete
Delete operation of resource: priority-limits
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PRIORITY-LIMITS - Retrieve
Retrieve operation of resource: priority-limits
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
PRIORITY-LIMIT - Update
Update operation of resource: priority-limit
priority-limitbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
Request Content-Types: application/json
Request Example
{ {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PRIORITY-LIMIT - Create
Create operation of resource: priority-limit
priority-limitbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
Request Content-Types: application/json
Request Example
{ {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PRIORITY-LIMIT - Delete
Delete operation of resource: priority-limit
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
PRIORITY-LIMIT - Retrieve
Retrieve operation of resource: priority-limit
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priority": "enumeration", Compute for all prefixes upto the\nspecified priority
Options:
critical-priority
high-priority
medium-priority
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
FRR-REMOTE-LFA-PREFIXES - Update
Update operation of resource: frr-remote-lfa-prefixes
frr-remote-lfa-prefixesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"prefix-list-name": "string", Name of the prefix list
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-REMOTE-LFA-PREFIXES - Create
Create operation of resource: frr-remote-lfa-prefixes
frr-remote-lfa-prefixesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"prefix-list-name": "string", Name of the prefix list
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-REMOTE-LFA-PREFIXES - Delete
Delete operation of resource: frr-remote-lfa-prefixes
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-REMOTE-LFA-PREFIXES - Retrieve
Retrieve operation of resource: frr-remote-lfa-prefixes
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"prefix-list-name": "string", Name of the prefix list
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
FRR-REMOTE-LFA-PREFIX - Update
Update operation of resource: frr-remote-lfa-prefix
frr-remote-lfa-prefixbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-REMOTE-LFA-PREFIX - Create
Create operation of resource: frr-remote-lfa-prefix
frr-remote-lfa-prefixbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-REMOTE-LFA-PREFIX - Delete
Delete operation of resource: frr-remote-lfa-prefix
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-REMOTE-LFA-PREFIX - Retrieve
Retrieve operation of resource: frr-remote-lfa-prefix
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level:
string
in path
ID of level
200 OK
Successful operation
400 Bad Request
Internal Error
FRR-TIEBREAKERS - Update
Update operation of resource: frr-tiebreakers
frr-tiebreakersbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TIEBREAKERS - Create
Create operation of resource: frr-tiebreakers
frr-tiebreakersbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TIEBREAKERS - Delete
Delete operation of resource: frr-tiebreakers
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TIEBREAKERS - Retrieve
Retrieve operation of resource: frr-tiebreakers
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
FRR-TIEBREAKER - Update
Update operation of resource: frr-tiebreaker
frr-tiebreakerbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level tiebreaker:
string
in path
ID of level tiebreaker
Request Content-Types: application/json
Request Example
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TIEBREAKER - Create
Create operation of resource: frr-tiebreaker
frr-tiebreakerbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level tiebreaker:
string
in path
ID of level tiebreaker
Request Content-Types: application/json
Request Example
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TIEBREAKER - Delete
Delete operation of resource: frr-tiebreaker
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level tiebreaker:
string
in path
ID of level tiebreaker
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-TIEBREAKER - Retrieve
Retrieve operation of resource: frr-tiebreaker
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level tiebreaker:
string
in path
ID of level tiebreaker
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"tiebreaker": "enumeration", Tiebreaker for which configuration\napplies
Options:
downstream
lc-disjoint
lowest-backup-metric
node-protecting
primary-path
secondary-path
srlg-disjoint
"index": "integer", Preference order among tiebreakers
range: "1..255"
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
FRR-USE-CAND-ONLIES - Update
Update operation of resource: frr-use-cand-onlies
frr-use-cand-onliesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-USE-CAND-ONLIES - Create
Create operation of resource: frr-use-cand-onlies
frr-use-cand-onliesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-USE-CAND-ONLIES - Delete
Delete operation of resource: frr-use-cand-onlies
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-USE-CAND-ONLIES - Retrieve
Retrieve operation of resource: frr-use-cand-onlies
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"frr-type": "enumeration", Computation Type
Options:
per-link
per-prefix
"level": "enumeration" Level to which configuration applies
Options:
not-set
level1
level2
}
]
}
}
FRR-USE-CAND-ONLY - Update
Update operation of resource: frr-use-cand-only
frr-use-cand-onlybody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-USE-CAND-ONLY - Create
Create operation of resource: frr-use-cand-only
frr-use-cand-onlybody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-USE-CAND-ONLY - Delete
Delete operation of resource: frr-use-cand-only
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
FRR-USE-CAND-ONLY - Retrieve
Retrieve operation of resource: frr-use-cand-only
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level frr-type:
string
in path
ID of level frr-type
200 OK
Successful operation
400 Bad Request
Internal Error
ROUTER-ID - Update
Update operation of resource: router-id
router-idbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ : { "interface-name": "string", Interface with designated stable IP\naddress to be used as a router ID. This\nmust be a Loopback interface. Precisely\none of Address and Interface must be\nspecified.
"address": "string" IPv4/IPv6 address to be used as a router\nID. Precisely one of Address and Interface\nmust be specified.
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ROUTER-ID - Create
Create operation of resource: router-id
router-idbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ : { "interface-name": "string", Interface with designated stable IP\naddress to be used as a router ID. This\nmust be a Loopback interface. Precisely\none of Address and Interface must be\nspecified.
"address": "string" IPv4/IPv6 address to be used as a router\nID. Precisely one of Address and Interface\nmust be specified.
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ROUTER-ID - Delete
Delete operation of resource: router-id
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ROUTER-ID - Retrieve
Retrieve operation of resource: router-id
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "interface-name": "string", Interface with designated stable IP\naddress to be used as a router ID. This\nmust be a Loopback interface. Precisely\none of Address and Interface must be\nspecified.
"address": "string" IPv4/IPv6 address to be used as a router\nID. Precisely one of Address and Interface\nmust be specified.
}
}
SPF-PREFIX-PRIORITIES - Update
Update operation of resource: spf-prefix-priorities
spf-prefix-prioritiesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SPF-PREFIX-PRIORITIES - Create
Create operation of resource: spf-prefix-priorities
spf-prefix-prioritiesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SPF-PREFIX-PRIORITIES - Delete
Delete operation of resource: spf-prefix-priorities
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SPF-PREFIX-PRIORITIES - Retrieve
Retrieve operation of resource: spf-prefix-priorities
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
]
}
}
SPF-PREFIX-PRIORITY - Update
Update operation of resource: spf-prefix-priority
spf-prefix-prioritybody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level prefix-priority-type:
string
in path
ID of level prefix-priority-type
Request Content-Types: application/json
Request Example
{ "prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SPF-PREFIX-PRIORITY - Create
Create operation of resource: spf-prefix-priority
spf-prefix-prioritybody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level prefix-priority-type:
string
in path
ID of level prefix-priority-type
Request Content-Types: application/json
Request Example
{ "prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SPF-PREFIX-PRIORITY - Delete
Delete operation of resource: spf-prefix-priority
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level prefix-priority-type:
string
in path
ID of level prefix-priority-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SPF-PREFIX-PRIORITY - Retrieve
Retrieve operation of resource: spf-prefix-priority
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
level prefix-priority-type:
string
in path
ID of level prefix-priority-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "prefix-priority-type": "enumeration", SPF Priority to assign matching prefixes
Options:
critical-priority
high-priority
medium-priority
"admin-tag": "integer", Tag value to determine prefixes for this\npriority
range: "1..4294967295"
"access-list-name": "string", Access List to determine prefixes for\nthis priority
"level": "enumeration" SPF Level for prefix prioritization
Options:
not-set
level1
level2
}
}
SUMMARY-PREFIXES - Update
Update operation of resource: summary-prefixes
summary-prefixesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"address-prefix": "string", IP summary address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" Level in which to summarize routes
range: "1..2"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Create
Create operation of resource: summary-prefixes
summary-prefixesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"address-prefix": "string", IP summary address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" Level in which to summarize routes
range: "1..2"
}
]
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Delete
Delete operation of resource: summary-prefixes
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Retrieve
Retrieve operation of resource: summary-prefixes
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"address-prefix": "string", IP summary address prefix
"tag": "integer", The tag value
range: "1..4294967295"
"level": "integer" Level in which to summarize routes
range: "1..2"
}
]
}
}
SUMMARY-PREFIX - Update
Update operation of resource: summary-prefix
summary-prefixbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix:
string
in path
ID of address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Create
Create operation of resource: summary-prefix
summary-prefixbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix:
string
in path
ID of address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Delete
Delete operation of resource: summary-prefix
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix:
string
in path
ID of address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Retrieve
Retrieve operation of resource: summary-prefix
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
address-prefix:
string
in path
ID of address-prefix
200 OK
Successful operation
400 Bad Request
Internal Error
MICRO-LOOP-AVOIDANCE - Update
Update operation of resource: micro-loop-avoidance
micro-loop-avoidancebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" MicroLoop avoidance enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MICRO-LOOP-AVOIDANCE - Create
Create operation of resource: micro-loop-avoidance
micro-loop-avoidancebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" MicroLoop avoidance enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MICRO-LOOP-AVOIDANCE - Delete
Delete operation of resource: micro-loop-avoidance
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
MICRO-LOOP-AVOIDANCE - Retrieve
Retrieve operation of resource: micro-loop-avoidance
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "rib-update-delay": "integer", Value of delay in msecs in updating RIB
range: "1000..65535"
units: "millisecond"
default: "5000"
"enable": "enumeration" MicroLoop avoidance enable configuration
Options:
not-set
micro-loop-avoidance-all
micro-loop-avoidance-protected
micro-loop-avoidance-segement-routing
}
}
UCMP - Update
Update operation of resource: ucmp
ucmpbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
UCMP - Create
Create operation of resource: ucmp
ucmpbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
UCMP - Delete
Delete operation of resource: ucmp
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
UCMP - Retrieve
Retrieve operation of resource: ucmp
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string" Name of the interface to be excluded
}
]
}, "variance": "integer", Value of variance
range: "101..10000"
default: "200"
"prefix-list-name": "string" Name of the Prefix List
},
"delay-interval": "integer" Delay in msecs between primary SPF and\nUCMP computation
range: "100..65535"
units: "millisecond"
default: "100"
}
}
ENABLE - Update
Update operation of resource: enable
enablebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ENABLE - Create
Create operation of resource: enable
enablebody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ENABLE - Delete
Delete operation of resource: enable
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
ENABLE - Retrieve
Retrieve operation of resource: enable
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
instance-name:
string
in path
ID of instance-name
af-name saf-name:
string
in path
ID of af-name saf-name
200 OK
Successful operation
400 Bad Request
Internal Error